Visual Studio 可自动生成标准的 XML 文档注释结构，进而帮助记录类和方法等代码元素。 在编译时，可生成一个包含文档注释的 XML 文件。 若要启用该选项，请在项目属性的“生成”>“输出”选项卡上选择“生成包含 API 文档的文件”。

提示

如果要为文档文件配置非默认名称和位置，请将 DocumentationFile 属性添加到 .csproj、.vbproj 或 .fsproj 文件中。

可随附 .NET 程序集一并分发编译器生成的 XML 文件，让 Visual Studio 和其他 IDE 能够快速显示类型和成员信息。 此外，可以通过 DocFX 和 Sandcastle 等工具运行 XML 文件，由此生成 API 引用网站。

注意

可在 C# 和 Visual Basic 中使用自动插入 XML 文档注释的“插入注释”命令。 但可在 C++ 文件中手动插入 XML 文档注释，这样仍可在编译时生成 XML 文档文件。

将文本光标放在要记录的元素上（例如，一种方法）。

执行下列操作之一：

在 C# 中键入 /// 或在 Visual Basic 中键入 '''

在“编辑”菜单上，选择“IntelliSense”>“插入注释”

在代码元素上或其正上方的右键单击或上下文菜单中，选择“代码段”>“插入代码段”

随即基于代码元素生成 XML 模板。 例如，对方法进行注释时，它会生成 元素，针对每个参数生成一个 元素，并生成一个记录返回值的 元素。

为每个 XML 元素输入说明以完整记录代码元素。

你可以在 XML 注释中使用样式，将鼠标悬停在元素上时这些样式将在“快速信息”中呈现。 这些样式包括：斜体、粗体、项目符号和可单击的链接。

注意

在 C# 中键入///（或在 Visual Basic 中键入 '''）后，可选择切换 XML 文档注释。 在菜单栏中，选择“工具”>“选项”以打开“选项”对话框。 然后，导航到“文本编辑器”>“C#”（或“Visual Basic”）>“高级”。 在“编辑器帮助”部分，查找“生成 XML 文档注释”选项 。